Skip to content

Update sphinx theme #348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed

Update sphinx theme #348

wants to merge 5 commits into from

Conversation

nwlandry
Copy link
Collaborator

@nwlandry nwlandry commented May 3, 2023

Based on @leotrs suggestion.

@codecov
Copy link

codecov bot commented May 3, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.06 🎉

Comparison is base (5497778) 90.36% compared to head (7b2339f) 90.42%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #348      +/-   ##
==========================================
+ Coverage   90.36%   90.42%   +0.06%     
==========================================
  Files          41       41              
  Lines        2988     3008      +20     
==========================================
+ Hits         2700     2720      +20     
  Misses        288      288              

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@nwlandry
Copy link
Collaborator Author

nwlandry commented May 3, 2023

I added a more organized and concrete contribution guide and eliminated some redundancy in the GH, PyPI, and RTD landing pages. Hopefully this addresses the reviewer's comments in our JOSS submission.

@maximelucas
Copy link
Collaborator

This theme is visually more pleasing. I just find two downsides to it:

  1. The full menu is not shown anywhere. It used to be shown as a left sidebar. Now it's horizontal at the top of the page, but after "Core Classes" it just says "More" with a dropdown menu.
  2. it feels much less compact than our current one, so I feel like I need to scroll a lot don't have a good overview of a page (I feel zoomed in). For example compare:

Is there a way to change that?

@leotrs
Copy link
Collaborator

leotrs commented May 4, 2023

Agree with Max, we should work on the top and side nav bars.

@nwlandry
Copy link
Collaborator Author

nwlandry commented May 4, 2023

Okay, I think it would make sense to split this into 2 PRs: this one will update the contributing guide and up-version sphinx, and a future PR will change the theme. How does this sound?

@nwlandry nwlandry closed this May 4, 2023
@nwlandry nwlandry deleted the update-sphinx-theme branch May 4, 2023 15:25
@leotrs
Copy link
Collaborator

leotrs commented May 4, 2023

Yeah that makes more sense. Thanks Nich.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants